

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>llvm-config - Print LLVM compilation options &mdash; LLVM 3.2 documentation</title>
    
    <link rel="stylesheet" href="../_static/llvm-theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '3.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="top" title="LLVM 3.2 documentation" href="../index.html" />
    <link rel="up" title="LLVM Command Guide" href="index.html" />
    <link rel="next" title="llvm-diff - LLVM structural ‘diff’" href="llvm-diff.html" />
    <link rel="prev" title="llvm-prof - print execution profile of LLVM program" href="llvm-prof.html" />
<style type="text/css">
  table.right { float: right; margin-left: 20px; }
  table.right td { border: 1px solid #ccc; }
</style>

  </head>
  <body>
<div class="logo">
  <a href="../index.html">
    <img src="../_static/logo.png"
         alt="LLVM Logo" width="250" height="88"/></a>
</div>

    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="llvm-diff.html" title="llvm-diff - LLVM structural ‘diff’"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="llvm-prof.html" title="llvm-prof - print execution profile of LLVM program"
             accesskey="P">previous</a> |</li>
  <li><a href="http://llvm.org/">LLVM Home</a>&nbsp;|&nbsp;</li>
  <li><a href="../index.html">Documentation</a>&raquo;</li>

          <li><a href="../userguides.html" >User Guides</a> &raquo;</li>
          <li><a href="index.html" accesskey="U">LLVM Command Guide</a> &raquo;</li> 
      </ul>
    </div>

      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">llvm-config - Print LLVM compilation options</a><ul>
<li><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
<li><a class="reference internal" href="#description">DESCRIPTION</a></li>
<li><a class="reference internal" href="#examples">EXAMPLES</a></li>
<li><a class="reference internal" href="#options">OPTIONS</a></li>
<li><a class="reference internal" href="#components">COMPONENTS</a></li>
<li><a class="reference internal" href="#exit-status">EXIT STATUS</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="llvm-prof.html"
                        title="previous chapter">llvm-prof - print execution profile of LLVM program</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="llvm-diff.html"
                        title="next chapter">llvm-diff - LLVM structural &#8216;diff&#8217;</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/CommandGuide/llvm-config.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="llvm-config-print-llvm-compilation-options">
<h1>llvm-config - Print LLVM compilation options<a class="headerlink" href="#llvm-config-print-llvm-compilation-options" title="Permalink to this headline">¶</a></h1>
<div class="section" id="synopsis">
<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<p><strong>llvm-config</strong> <em>option</em> [<em>components</em>...]</p>
</div>
<div class="section" id="description">
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p><strong>llvm-config</strong> makes it easier to build applications that use LLVM.  It can
print the compiler flags, linker flags and object libraries needed to link
against LLVM.</p>
</div>
<div class="section" id="examples">
<h2>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<p>To link against the JIT:</p>
<div class="highlight-sh"><div class="highlight"><pre>g++ <span class="sb">`</span>llvm-config --cxxflags<span class="sb">`</span> -o HowToUseJIT.o -c HowToUseJIT.cpp
g++ <span class="sb">`</span>llvm-config --ldflags<span class="sb">`</span> -o HowToUseJIT HowToUseJIT.o <span class="se">\</span>
    <span class="sb">`</span>llvm-config --libs engine bcreader scalaropts<span class="sb">`</span>
</pre></div>
</div>
</div>
<div class="section" id="options">
<h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
<p><strong>&#8211;version</strong></p>
<blockquote>
<div>Print the version number of LLVM.</div></blockquote>
<p><strong>-help</strong></p>
<blockquote>
<div>Print a summary of <strong>llvm-config</strong> arguments.</div></blockquote>
<p><strong>&#8211;prefix</strong></p>
<blockquote>
<div>Print the installation prefix for LLVM.</div></blockquote>
<p><strong>&#8211;src-root</strong></p>
<blockquote>
<div>Print the source root from which LLVM was built.</div></blockquote>
<p><strong>&#8211;obj-root</strong></p>
<blockquote>
<div>Print the object root used to build LLVM.</div></blockquote>
<p><strong>&#8211;bindir</strong></p>
<blockquote>
<div>Print the installation directory for LLVM binaries.</div></blockquote>
<p><strong>&#8211;includedir</strong></p>
<blockquote>
<div>Print the installation directory for LLVM headers.</div></blockquote>
<p><strong>&#8211;libdir</strong></p>
<blockquote>
<div>Print the installation directory for LLVM libraries.</div></blockquote>
<p><strong>&#8211;cxxflags</strong></p>
<blockquote>
<div>Print the C++ compiler flags needed to use LLVM headers.</div></blockquote>
<p><strong>&#8211;ldflags</strong></p>
<blockquote>
<div>Print the flags needed to link against LLVM libraries.</div></blockquote>
<p><strong>&#8211;libs</strong></p>
<blockquote>
<div>Print all the libraries needed to link against the specified LLVM
<em>components</em>, including any dependencies.</div></blockquote>
<p><strong>&#8211;libnames</strong></p>
<blockquote>
<div>Similar to <strong>&#8211;libs</strong>, but prints the bare filenames of the libraries
without <strong>-l</strong> or pathnames.  Useful for linking against a not-yet-installed
copy of LLVM.</div></blockquote>
<p><strong>&#8211;libfiles</strong></p>
<blockquote>
<div>Similar to <strong>&#8211;libs</strong>, but print the full path to each library file.  This is
useful when creating makefile dependencies, to ensure that a tool is relinked if
any library it uses changes.</div></blockquote>
<p><strong>&#8211;components</strong></p>
<blockquote>
<div>Print all valid component names.</div></blockquote>
<p><strong>&#8211;targets-built</strong></p>
<blockquote>
<div>Print the component names for all targets supported by this copy of LLVM.</div></blockquote>
<p><strong>&#8211;build-mode</strong></p>
<blockquote>
<div>Print the build mode used when LLVM was built (e.g. Debug or Release)</div></blockquote>
</div>
<div class="section" id="components">
<h2>COMPONENTS<a class="headerlink" href="#components" title="Permalink to this headline">¶</a></h2>
<p>To print a list of all available components, run <strong>llvm-config
&#8211;components</strong>.  In most cases, components correspond directly to LLVM
libraries.  Useful &#8220;virtual&#8221; components include:</p>
<p><strong>all</strong></p>
<blockquote>
<div>Includes all LLVM libaries.  The default if no components are specified.</div></blockquote>
<p><strong>backend</strong></p>
<blockquote>
<div>Includes either a native backend or the C backend.</div></blockquote>
<p><strong>engine</strong></p>
<blockquote>
<div>Includes either a native JIT or the bitcode interpreter.</div></blockquote>
</div>
<div class="section" id="exit-status">
<h2>EXIT STATUS<a class="headerlink" href="#exit-status" title="Permalink to this headline">¶</a></h2>
<p>If <strong>llvm-config</strong> succeeds, it will exit with 0.  Otherwise, if an error
occurs, it will exit with a non-zero value.</p>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="llvm-diff.html" title="llvm-diff - LLVM structural ‘diff’"
             >next</a> |</li>
        <li class="right" >
          <a href="llvm-prof.html" title="llvm-prof - print execution profile of LLVM program"
             >previous</a> |</li>
  <li><a href="http://llvm.org/">LLVM Home</a>&nbsp;|&nbsp;</li>
  <li><a href="../index.html">Documentation</a>&raquo;</li>

          <li><a href="../userguides.html" >User Guides</a> &raquo;</li>
          <li><a href="index.html" >LLVM Command Guide</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, LLVM Project.
      Last updated on 2012-12-21.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    </div>
  </body>
</html>